πŸ•ΈοΈ Ada Research Browser

README.md
← Back

Compliance Auditor

AI-powered document compliance analysis application built with Next.js, Supabase, and OpenAI/Anthropic.

Features

Tech Stack

Getting Started

Prerequisites

Quick start (new project setup)

  1. Clone and enter the repository: bash git clone <your-repo-url> cd <your-repo-directory>

  2. Run the bootstrap script: bash bash scripts/bootstrap.sh

  3. Update .env.local with real values: env NEXT_PUBLIC_SUPABASE_URL=your_supabase_url NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key SUPABASE_SERVICE_ROLE_KEY=your_supabase_service_role_key OPENAI_API_KEY=your_openai_api_key ANTHROPIC_API_KEY=your_anthropic_api_key

  4. Set up the database by running supabase/schema.sql in Supabase SQL Editor.

  5. Start the development server: bash npm run dev

  6. Open http://localhost:3000 in your browser.

Project Structure

.
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ (auth)/           # Auth pages (login, signup)
β”‚   β”œβ”€β”€ (dashboard)/      # Protected dashboard pages
β”‚   β”œβ”€β”€ api/              # API routes
β”‚   └── auth/             # Auth callback handler
β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ ui/               # Shadcn UI components
β”‚   └── ...               # Custom components
β”œβ”€β”€ lib/
β”‚   β”œβ”€β”€ ai/               # AI provider integrations
β”‚   β”œβ”€β”€ parsers/          # Document parsers (PDF, DOCX, TXT)
β”‚   └── supabase/         # Supabase client configurations
β”œβ”€β”€ scripts/
β”‚   └── bootstrap.sh      # First-time setup helper
β”œβ”€β”€ supabase/
β”‚   └── schema.sql        # Database schema
└── types/
    └── index.ts          # TypeScript type definitions

Usage

  1. Sign Up/Login: Create an account or sign in
  2. Upload Documents: Navigate to Upload and drag & drop your files
  3. View Analysis: Documents are automatically analyzed after upload
  4. Review Risks: Click on a document to see detailed risk findings
  5. Configure AI: Go to Settings to switch between OpenAI and Anthropic

API Routes

Security

License

MIT